Welcome
Welcome to WinHelp Video Wizard

 WinHelp Video Wizard is used to configure WinHelp Help systems for video and sound. It is primarily used for WinHelp 3 Help systems (for Windows 3.1), however it can provide additional multimedia functionality to WinHelp 4 Help systems (for Windows 95, 98, NT 4.0, and 2000). If you are creating HTML Help systems, you do not need to use the WinHelp Video Wizard.

See Also

Overview of adding multimedia to WinHelp 3 Help systems

Overview of adding multimedia to WinHelp 4 Help systems

System requirements

Starting WinHelp Video Wizard

Using video and sound macros

Distributing multimedia with WinHelp 4 Help systems

Distributing multimedia with WinHelp 3 Help systems

Troubleshooting

Video Wizard additions to the Help project

Contacting eHelp Corporation


System requirements

•	WinHelp Video Wizard is designed for WinHelp 3 or WinHelp 4 Help projects.

•	WinHelp Video Wizard works on any standard Windows Operating System (Windows 3.1, 95, 98, NT 4.0, and 2000).

•	There are two versions of RHMMPLAY.DLL. A 16-bit version to be shipped with WinHelp 3 Help systems and a 32-bit version to be shipped with WinHelp 4 Help systems.


eHelp Corporation headquarters

eHelp Corporation is the worldwide leader in Help authoring solutions. Software developers, Help authors, technical writers, and documentation experts worldwide turn to eHelp Corporation for state-of-the-art Help authoring and Internet/intranet solutions.

Corporate Headquarters

Address:	eHelp Corporation 7777 Fay Avenue, Suite 201 La Jolla, CA 92037 U.S.A.
Telephone:	1-858-551-2485
Fax:	1-858-551-2486
World Wide Web:	www.blue-sky.com
Office Hours:	Monday to Friday 6:00 A.M. to 5:00 P.M. Pacific Time

eHelp Corporation Sales Department

eHelp Corporation Technical Support Department


Sales

eHelp Corporation's professional sales staff is ready to answer your sales questions Monday to Friday from 6:00 A.M. to 5:00 P.M. Pacific Time.

Contact your sales representative to hear about the latest products, the Subscription Plan, training, upgrade options and prices, and more. If you have a technical question or problem, please contact Technical Support.

Contacting your eHelp Corporation Sales Representative

Sales Phone:	1-800-677-4946
International (including Canada):	1-858-459-6365
Sales Fax:	1-858-459-6366
World Wide Web:	www.blue-sky.com
Sales Email:	sales@blue-sky.com
When sending email, please include your company name, city, and state to ensure your request is handled promptly.


Technical Support

At eHelp Corporation, we work hard to provide you with intuitive technical products. Additionally, we try to provide superior online and print documentation to enable you to work independently. If you have a technical question that you can't answer with the provided tools, please contact our Technical Support department. All of our Technical Support representatives are eager to answer your questions and help you create the best Help systems possible.

Note: You must be a registered user to access eHelp Corporation support services. eHelp Corporation support services are subject to the prices, terms, and conditions in place at the time the service is used.

eHelp Corporation's Technical Support services includes email, telephone, and Web-based support on our corporate Web site (www.blue-sky.com).

Help Us Help You

When contacting Technical Support via phone or email, please provide the following information for the fastest possible service:

•	Product serial number (registration number)

•	Your name, company name, and phone number

•	Exact product name and version number

•	Type of operating system (e.g., Windows 95)

•	Version of Microsoft Word (if using RoboHELP for WinHelp)

•	Browser and version (if creating HTML-based Help)

•	Complete description of the issue, including steps to reproduce it

•	Exact wording of any messages displayed when you encountered the problem

•	Steps taken to resolve the problem

•	All previous email threads with eHelp Corporation about the issue, if any

For current hours of operation and details about all support offerings, please:

•	Visit our Web site (www.blue-sky.com)

•	Email us at supportnews@blue-sky.com to receive an automated reply listing all of your support options.

•	Call us at 858-551-2194.


Premium Support

Premium Support entitles plan members to priority Technical Support access through a dedicated telephone line and a dedicated email address. Plan members receive direct access to eHelp Corporation's seasoned Senior Technical Support Engineers.

Premium Support plans are available for current and previous versions of eHelp Corporation products.


Adding sound and video to Help systems
Overview of adding multimedia to WinHelp 3 Help systems

WinHelp 3 does not automatically support video and sound files. Blue Sky has extended the multimedia capabilities of WinHelp 3 in the WinHelp Video Kit. The WinHelp Video Kit includes the WinHelp Video Wizard and the RHMMPLAY DLL. You simply:

•	Use WinHelp Video Wizard to register the DLL in your Help project.

•	Add the video or sound files to the project using the macros in RHMMPLAY DLL.

•	Distribute the 16-bit version of RHMMPLAY DLL and the multimedia files with your Help project.

What do you want to do?

Start WinHelp Video Wizard

View options for adding multimedia files to a Help project

Learn more about distributing a multimedia enhanced WinHelp 3 project


Overview of adding multimedia to HTML Help systems

It is easy to add multimedia to HTML Help systems, especially if you use RoboHTML.

1	Start RoboHTML and open the Help project.

2	Navigate to the topic which will contain the multimedia file.

3	From the RoboHTML Insert menu, choose Multimedia.

For more information on including video in HTML Help systems, see the RoboHTML Help system.


Overview of adding multimedia to WinHelp 4 systems
Overview of adding multimedia to WinHelp 4 Help systems

There are two options for adding video and sound to WinHelp 4 systems

•	WinHelp 4's MCI command

•	The WinHelp Video Kit

Each option has it's particular strengths, depending on what you want to achieve. It's a good idea to try each method in a small sample file to determine which you prefer.

Benefits of using WinHelp 4's built-in MCI Command

•	More control over media placement, display and play functionality.

•	The ability to specify repeating videos.

•	You do not have to ship an additional DLL with your Help file.

Benefits of using the WinHelp Video Kit

•	You can play video or sound files from a hotspot or button without changing topics.

•	The ability to set a custom caption on the video player.

•	Play a sound file with no video player displayed.

•	You do need to ship the RHMMPLAY DLL with your Help project with this option.

What do you want to do?

Use the MCI Command

Use the WinHelp Video Kit


Adding Multimedia using the WinHelp 4 MCI Command
Using the WinHelp 4 MCI Command

1	Open the Help project in RoboHELP.

2	From the RoboHELP Insert menu, click Help Multimedia.

3	From the List Files of Type list, choose video (AVI) or sound (WAV).

4	Click Browse to navigate to the video or sound file you want to insert.

5	Select any Display or Play options.

6	Click OK.

For more information on this command, refer to RoboHELP's online Help.


Using the WinHelp Video Wizard Method
Using the WinHelp Video Kit

The WinHelp Video Kit includes the WinHelp Video Wizard and the RHMMPLAY DLL. To use this method of adding multimedia to a WinHelp 4 Help project, you simply:

•	Use WinHelp Video Wizard to register the DLL in your project.

•	Add the video or sound files to the project by using the macros contained in RHMMPLAY DLL.

•	Distribute the 32-bit version of RHMMPLAY DLL with your Help project.

What do you want to do?

Learn how to use WinHelp Video Wizard

Find out options for adding video or sound files to a Help project

Find out what to distribute with a multimedia enhanced WinHelp 4 project


Starting WinHelp Video Wizard
Using WinHelp Video Wizard

The WinHelp Video Wizard updates your Help project by registering the macros found in the RHMMPLAY DLL. This allows the project to support video and sound. You can start WinHelp Video Wizard while you have a project open in RoboHELP, or you can start Video Wizard standalone.

To start Video Wizard from within RoboHELP:

•	From the RoboHELP Explorer Tools tab, double-click Video Wizard [image]. The Video Wizard window appears.

To start Video Wizard from RoboHELP Office:

1	From the Start menu, choose Programs, RoboHELP Office, RoboHELP Office.

If you are on Windows 3.1, open the RoboHELP Office program group.

2	Double-click Video Wizard [image]. The Video Wizard window appears.

To use WinHelp Video Wizard:

1	Choose a Windows Help project to which you will add video and sound functionality.

2	Click Next.

3	Choose to add the ability to play video (.avi), sound (.wav) or both.

4	Click Next. Your Help project is now updated to support video and/or sound.

5	Next, add the specific video and sound files to the desired topics in your Help project.

Tip: If you ever want to remove the added video and/or sound functionality, simply run the WinHelp Video Wizard on your project then deselect the options to add video or sound. The functionality will be removed.

See Also

Adding multimedia to Help systems

Video Wizard additions to the Help project


Using Sound and Video Macros
Using the RHMMPLAY video and sound macros

The RHMMPLAY video and sound macros give you a multitude of options for customizing the way your multimedia files play. You can:

•	Add multimedia files that play automatically when your user enters a topic. When the user jumps to a particular topic, the video or sound begins to play.

•	Add multimedia files that play when your user clicks a hotspot or hotspot graphic. This option is useful if you want your user to read something before starting the video. Or, to make a list of hotspots comparing different sounds.

Additionally, there are advanced options. You can:

•	Play a sound file without the video/sound player displayed. Your user simply hears a sound upon entering a topic or clicking a hotspot.

•	Change the caption on the video/sound player. By default, it displays the status of the file, such as "Playing" or "Stopped". You can set it to any desired caption.

•	Remove the menu from the video/sound player. This allows you to prevent your user from selecting certain video/sound options.

•	Hard code a path to the video sound files.

What do you want to do?

Add files that play automatically

Add files that play with the click of a hotspot or graphic

Play a sound file without the sound player displayed

Change the caption of the video/sound player

Remove the menu from the video/sound player

Hard code a path to the video/sound files


Autoplaying a video or sound file

To include a video or sound file so that it plays automatically when the topic is opened:

1	Open the Help project

2	Place the cursor in the appropriate topic.

3	Choose Edit Topic Properties.

4	Click the Advanced tab.

5	Click the Entry Macro button.

6	For the Macro Command Script, type:

video("filename.avi")   (where filename.avi is the name of the video file you are inserting)

or

sound("filename.wav")    (where filename.wav is the name of the sound file you are inserting)

7	Click OK twice.


Playing a video or sound file from a hotspot

To play a video or sound file from a hotspot:

1	Open the Help project in RoboHELP.

2	Navigate to the topic which will contain the multimedia file.

3	From the Insert menu, choose Help Macro Hotspot.

4	In the Macro to execute window type:

video("filename.avi")   (where filename.avi is the name of the video file you are inserting)

or

sound("filename.wav")    (where filename.wav is the name of the sound file you are inserting)

3	In the Hotspot Text field, specify a hotspot. The hotspot that launches your file can be either text or a graphic such as a button.

4	Click OK.


Playing a sound file without the video/sound player displayed

The SoundOnly macro allows you to play a WAV sound file without the Video/Sound Player displayed.

1	Open the Help project in RoboHELP.

2	Navigate to the topic which will contain the sound file.

3	From the Insert menu, choose Help Macro Hotspot.

4	In the Macro to execute window type:

SoundOnly("Mysound.wav")   	(where Mysound..wav is the name of the sound file you are inserting)

3	In the Hotspot Text field, specify a hotspot. The hotspot that launches your file can be either text or a graphic such as a button.

4	Click OK.


Setting the caption of the video/sound player

The VideoCaption macro allows you to change the caption displayed in the Video/Sound Player. The default is to display the status of the Video/Sound Player, such as "Playing" or "Stopped." The syntax for this macro is:

•	VideoCaption("Any Caption")

To set the caption, place this macro before the macro that calls the video or sound file. Note that the new caption stays in effect until the macro is called again to change it.

Adding the VideoCaption macro

The following steps show how you would use this macro when you are playing a multimedia file from a hotspot. You could also use the VideoCaption macro before autoplaying a video.

1	Open the Help project in RoboHELP.

2	Navigate to the topic which will contain the multimedia file.

3	From the Insert menu, choose Help Macro Hotspot.

4	In the Macro to execute window type:

VideoCaption("Any Caption")

Video("filename.avi")   (where filename.avi is the name of the video file you are inserting)

3	In the Hotspot Text field, specify a hotspot. The hotspot that launches your file can be either text or a graphic such as a button.

4	Click OK.

Example

If you turn on TrueCode in RoboHELP, you'll see the syntax for the added macros. This example changes the title of the Video/Sound Player to "New Caption" and then plays the video called "tutor.avi."

ClickHere!VideoCaption("New Caption");video("tutor.avi")


Removing the Menu from the video/sound player

The VideoMenu macro allows you to specify whether the Video/Sound Player menu displays for your end user to use. The default is that the menu is displayed.

To turn the menu on or off, place this macro before the macro that calls the video or sound file. Note that the menu setting stays in effect until the macro is called again to change it.

Syntax

To remove the menu from the Video/Sound Player:

VideoMenu("off")

To reinstate the menu to the Video/Sound Player:

VideoMenu("on")

Removing the menu

The following steps show how you would use this macro when you are playing a multimedia file from a hotspot. You could also use the VideoMenu macro before autoplaying a video.

1	Open the Help project in RoboHELP.

2	Navigate to the topic which will contain the multimedia file.

3	From the Insert menu, choose Help Macro Hotspot.

4	In the Macro to execute window type:

VideoMenu("off")

Video("filename.avi")   (where filename.avi is the name of the video file you are inserting)

3	In the Hotspot Text field, specify a hotspot. The hotspot that launches your file can be either text or a graphic such as a button.

4	Click OK.

Example

If you turn on TrueCode in RoboHELP, you'll see the syntax for the added macros. This example displays the video tutor.avi in a window with no menu button.

ClickHere!VideoMenu("off");video("tutor.avi")


Hard coding a path to the video and sound files

The VideoPath macro allows you to hard code a path to video and sound files. It allows you to specify a directory that is not the same directory as the Help file and/or not in the path.

The Video/Sound Player uses the directory specified in the last executed VideoPath macro. Place the VideoPath macro before the macro that calls the video or sound file.

Hard Coding a Path

The following steps show how you would use this macro when you are playing a multimedia file from a hotspot. You could also use this macro before autoplaying a video.

1	Open the Help project in RoboHELP.

2	Navigate to the topic which will contain the multimedia file.

3	From the Insert menu, choose Help Macro Hotspot.

4	In the Macro to execute window type:

VidePath("d:\\dir\\videos")

Video("filename.avi")   (where filename.avi is the name of the video file you are inserting)

3	In the Hotspot Text field, specify a hotspot. The hotspot that launches your file can be either text or a graphic such as a button.

4	Click OK.

Example

If you turn on TrueCode in RoboHELP, you'll see the syntax for the added macros.

ClickHere!VideoPath("d:\\dir\\videos");video("test.avi")


Shipping video with your Help systems
Shipping video or sound with WinHelp 3 Help systems

The following files must be distributed with your WinHelp Help system if you have added multimedia functionality using the WinHelp Video Wizard and the RHMMPLAY DLL:

•	Any multimedia files (AVI and WAV files) that are part of the Help system

•	The 16-bit version of RHMMPLAY.DLL. Note that there are two versions of RHMMPLAY. The 16-bit version is for WinHelp 3 Help systems only. The 32-bit version is for WinHelp 4 Help systems. You will find the 16-bit version of RHMMPLAY.DLL on your system in C:\WinHelp\Video16.

•	Video for Windows 1.1 Runtime

Where should I install RHMMPLAY.DLL on my users system?

•	RHMMPLAY.DLL must be installed in either C:\Windows\System or in the same directory as the video-enabled HLP file it supports.

Video for Windows 1.1 Runtime

For Windows 3.1 Help systems that include video, Video for Windows 1.1 Runtime must be available for end-users. If you are not sure if your users will have it, it can be shipped with your Help system. Video for Windows 1.1 Runtime is provided as a separate install on the RoboHELP Office CD-ROM.


Shipping video and sound with WinHelp 4 Help systems

The following files must be distributed with your WinHelp 4 Help system if you have added multimedia functionality using the WinHelp Video Wizard and the RHMMPLAY DLL:

•	Any multimedia files (AVI and WAV files) that are part of the Help system

•	The 32-bit version of RHMMPLAY.DLL. Note that there are two versions of RHMMPLAY. The 16-bit version is for WinHelp 3 Help systems only. The 32-bit version is for WinHelp 4 Help systems. You will find the 32-bit version of RHMMPLAY.DLL on your system in C:\WinHelp\Video32.

Where should I install RHMMPLAY.DLL on my users system?

•	RHMMPLAY.DLL should be installed in either C:\Windows\System or in the same directory as the video-enabled HLP file it supports.


Troubleshooting
Troubleshooting while adding videos to a Help project

Help Compiler Warning 3532: Undefined function

The macro name may be incorrect. Either it has been typed incorrectly, or the macro is not registered in the HPJ file. Check the spelling of the macro name listed in the error message—if it is correct, try running WinHelp Video Wizard on your HPJ file.

Help Compiler Warning 3591: Syntax error

The macro call may be missing a quote or a parenthesis. Check to be sure the media file your macro is calling is enclosed in quotes and parentheses. For example:

video("earth.avi")

sound("waves.wav")

Cannot open the file name.avi.

The Video Player cannot find the file named in the Help system. Check that in your macro call, you do not have a space between the file name and the quotation marks. Then check the location of your media files. The media files must be located in any of the following:

•	The same directory as the Help system.

•	A directory included in the Path statement in the AUTOEXEC.BAT file.

•	The directory specified in the previous instance of the VideoPath macro.

Routine not found.

The file RHMMPLAY.DLL can not be located. For more information, see shipping video with your Help systems.


Video Wizard Additions to the Help Project
WinHelp Video Wizard additions to the Help project

This topic is provided for your reference if you are using the WinHelp Video Kit to add multimedia functionality to a Help project. When you run WinHelp Video Kit's Video Wizard on a Help project, Video Wizard registers special macros that are needed for your Help system to run video and sound. The macros are registered in your project's Help Project File (HPJ). If you choose support for both video and sound, the following lines will be added to the [CONFIG] section of your HPJ file:

RegisterRoutine("rhmmplay.dll", "VideoPath", "S") ;=

RegisterRoutine("rhmmplay.dll", "VideoCaption", "S") ;=

RegisterRoutine("rhmmplay.dll", "VideoMenu", "S") ;=

RegisterRoutine("rhmmplay.dll", "Video", "S") ;=

RegisterRoutine("rhmmplay.dll", "Sound", "S") ;=

RegisterRoutine("rhmmplay.dll", "SoundOnly", "S") ;=

VideoPath(qchpath) ;=

Tip: If you ever want to remove the added video and/or sound functionality, you can either delete the above lines from the HPJ file (also remember to remove any macro's you've added to topics) or simply run the WinHelp Video Wizard on your project then deselect the options to add video or sound. The functionality will be removed.